<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Core Plot (iOS): CPTBarPlot Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="core-plot-logo.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Core Plot (iOS)
   
   </div>
   <div id="projectbrief">Cocoa plotting framework for Mac OS X and iOS</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Animation&#160;&&#160;Constants</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('interface_c_p_t_bar_plot.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">CPTBarPlot Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="CPTBarPlot" --><!-- doxytag: inherits="CPTPlot" -->
<p>A two-dimensional bar plot.  
 <a href="interface_c_p_t_bar_plot.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CPTBarPlot:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_bar_plot__inherit__graph.png" border="0" usemap="#_c_p_t_bar_plot_inherit__map" alt="Inheritance graph"/></div>
<map name="_c_p_t_bar_plot_inherit__map" id="_c_p_t_bar_plot_inherit__map">
<area shape="rect" id="node2" href="interface_c_p_t_plot.html" title="An abstract plot class." alt="" coords="206,406,276,437"/><area shape="rect" id="node4" href="interface_c_p_t_annotation_host_layer.html" title="A container layer for annotations." alt="" coords="150,326,332,357"/><area shape="rect" id="node6" href="interface_c_p_t_layer.html" title="Base class for all Core Animation layers in Core Plot." alt="" coords="201,246,281,277"/><area shape="rect" id="node8" href="http://developer.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CALayer_class/Introduction/Introduction.html" title="CALayer" alt="" coords="140,166,213,197"/><area shape="rect" id="node10" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="5,86,85,117"/><area shape="rect" id="node12" href="http://developer.apple.com/iPhone/library/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="117,6,235,37"/><area shape="rect" id="node16" href="protocol_c_p_t_responder-p.html" title="The basis of all event processing in Core Plot." alt="" coords="238,166,375,197"/><area shape="rect" id="node14" href="http://www.devworld.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CAMediaTiming_protocol/Introduction/Introduction.html" title="\&lt;CAMediaTiming&#45;p\&gt;" alt="" coords="109,86,269,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for CPTBarPlot:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="interface_c_p_t_bar_plot__coll__graph.png" border="0" usemap="#_c_p_t_bar_plot_coll__map" alt="Collaboration graph"/></div>
<map name="_c_p_t_bar_plot_coll__map" id="_c_p_t_bar_plot_coll__map">
<area shape="rect" id="node2" href="interface_c_p_t_plot.html" title="An abstract plot class." alt="" coords="206,406,276,437"/><area shape="rect" id="node4" href="interface_c_p_t_annotation_host_layer.html" title="A container layer for annotations." alt="" coords="150,326,332,357"/><area shape="rect" id="node6" href="interface_c_p_t_layer.html" title="Base class for all Core Animation layers in Core Plot." alt="" coords="201,246,281,277"/><area shape="rect" id="node8" href="http://developer.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CALayer_class/Introduction/Introduction.html" title="CALayer" alt="" coords="140,166,213,197"/><area shape="rect" id="node10" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Classes/NSObject_Class/Reference/Reference.html" title="NSObject" alt="" coords="5,86,85,117"/><area shape="rect" id="node12" href="http://developer.apple.com/iPhone/library/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="117,6,235,37"/><area shape="rect" id="node16" href="protocol_c_p_t_responder-p.html" title="The basis of all event processing in Core Plot." alt="" coords="238,166,375,197"/><area shape="rect" id="node14" href="http://www.devworld.apple.com/iphone/library/documentation/GraphicsImaging/Reference/CAMediaTiming_protocol/Introduction/Introduction.html" title="\&lt;CAMediaTiming&#45;p\&gt;" alt="" coords="109,86,269,117"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_c_p_t_bar_plot-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Public Class Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Factory Methods</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_c_p_t_bar_plot.html">CPTBarPlot</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_c_p_t_bar_plot.html#ac12f1fb03d8762d6e718acb0a2cd077f">tubularBarPlotWithColor:horizontalBars:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns a new <a class="el" href="interface_c_p_t_bar_plot.html" title="A two-dimensional bar plot.">CPTBarPlot</a> instance initialized with a bar fill consisting of a linear gradient between black and the given color.  <a href="#ac12f1fb03d8762d6e718acb0a2cd077f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d1abb45a60f9daa990b9ea7d68d17f7"></a><!-- doxytag: member="CPTBarPlot::barWidthsAreInViewCoordinates" ref="a9d1abb45a60f9daa990b9ea7d68d17f7" args="" -->
<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#a9d1abb45a60f9daa990b9ea7d68d17f7">barWidthsAreInViewCoordinates</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the bar width and bar offset is in view coordinates, or in plot coordinates. Default is NO, meaning plot coordinates are used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Miscellaneous/Foundation_DataTypes/Reference/reference.html">NSDecimal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#a82f1434ff5a5b98ef005dca5feee1572">barWidth</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of each bar. Either view or plot coordinates can be used.  <a href="#a82f1434ff5a5b98ef005dca5feee1572"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9ccd0b2ed6a06298e6f4585bf3e95279"></a><!-- doxytag: member="CPTBarPlot::barWidthScale" ref="ga9ccd0b2ed6a06298e6f4585bf3e95279" args="" -->
CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__plot_animation_bar_plot.html#ga9ccd0b2ed6a06298e6f4585bf3e95279">barWidthScale</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">An animatable scaling factor for the bar width. Default is 1.0. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2f71205bdb735ddc2abaebb3e56ff75"></a><!-- doxytag: member="CPTBarPlot::barOffset" ref="aa2f71205bdb735ddc2abaebb3e56ff75" args="" -->
<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Miscellaneous/Foundation_DataTypes/Reference/reference.html">NSDecimal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#aa2f71205bdb735ddc2abaebb3e56ff75">barOffset</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The starting offset of the first bar in location data units. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacf7d5567082b089e0ddcc5664eecb0db"></a><!-- doxytag: member="CPTBarPlot::barOffsetScale" ref="gacf7d5567082b089e0ddcc5664eecb0db" args="" -->
CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__plot_animation_bar_plot.html#gacf7d5567082b089e0ddcc5664eecb0db">barOffsetScale</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">An animatable scaling factor for the bar offset. Default is 1.0. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga880361dd6ad4a3e7f1c26f56c7ed84cd"></a><!-- doxytag: member="CPTBarPlot::barCornerRadius" ref="ga880361dd6ad4a3e7f1c26f56c7ed84cd" args="" -->
CGFloat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__plot_animation_bar_plot.html#ga880361dd6ad4a3e7f1c26f56c7ed84cd">barCornerRadius</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The corner radius for the end of the bars. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada02529fb454bde898da35acaba1ed83"></a><!-- doxytag: member="CPTBarPlot::lineStyle" ref="ada02529fb454bde898da35acaba1ed83" args="" -->
<a class="el" href="interface_c_p_t_line_style.html">CPTLineStyle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#ada02529fb454bde898da35acaba1ed83">lineStyle</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The line style for the bar outline. If nil, the outline is not drawn. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38eeae57017ee0081117b0f1947da3ef"></a><!-- doxytag: member="CPTBarPlot::fill" ref="a38eeae57017ee0081117b0f1947da3ef" args="" -->
<a class="el" href="interface_c_p_t_fill.html">CPTFill</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#a38eeae57017ee0081117b0f1947da3ef">fill</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The fill style for the bars. If nil, the bars are not filled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1734ee6979130d887f2a95cd5081a83"></a><!-- doxytag: member="CPTBarPlot::barsAreHorizontal" ref="ad1734ee6979130d887f2a95cd5081a83" args="" -->
<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#ad1734ee6979130d887f2a95cd5081a83">barsAreHorizontal</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If YES, the bars will have a horizontal orientation, otherwise they will be vertical. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61030b1cf4e726b5d9a67a07b8c78a89"></a><!-- doxytag: member="CPTBarPlot::baseValue" ref="a61030b1cf4e726b5d9a67a07b8c78a89" args="" -->
<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/Foundation/Miscellaneous/Foundation_DataTypes/Reference/reference.html">NSDecimal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#a61030b1cf4e726b5d9a67a07b8c78a89">baseValue</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The coordinate value of the fixed end of the bars. This is only used if barsHaveVariableBases is NO. Otherwise, the data source will be queried for an appropriate value of CPTBarPlotFieldBarBase. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbd260f801d950fd944638b757597b06"></a><!-- doxytag: member="CPTBarPlot::barBasesVary" ref="abbd260f801d950fd944638b757597b06" args="" -->
<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#abbd260f801d950fd944638b757597b06">barBasesVary</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If YES, a constant base value is used for all bars (baseValue). If NO, the data source is queried to supply a base value for each bar. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_c_p_t_plot_range.html">CPTPlotRange</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_c_p_t_bar_plot.html#afbe47324c211948bcc6554f44cba9740">plotRange</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the plot range for the independent axis.  <a href="#afbe47324c211948bcc6554f44cba9740"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A two-dimensional bar plot. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>See <a class="el" href="group__plot_animation_bar_plot.html">Bar Plot</a> for a list of animatable properties. </dd></dl>
</div><hr/><h2>Method Documentation</h2>
<a class="anchor" id="ac12f1fb03d8762d6e718acb0a2cd077f"></a><!-- doxytag: member="CPTBarPlot::tubularBarPlotWithColor:horizontalBars:" ref="ac12f1fb03d8762d6e718acb0a2cd077f" args="(CPTColor *color,[horizontalBars] BOOL horizontal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (<a class="el" href="interface_c_p_t_bar_plot.html">CPTBarPlot</a> *) tubularBarPlotWithColor: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_color.html">CPTColor</a> *)&#160;</td>
          <td class="paramname"><em>color</em></td>
        </tr>
        <tr>
          <td class="paramkey">horizontalBars:</td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/iphone/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>)&#160;</td>
          <td class="paramname"><em>horizontal</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates and returns a new <a class="el" href="interface_c_p_t_bar_plot.html" title="A two-dimensional bar plot.">CPTBarPlot</a> instance initialized with a bar fill consisting of a linear gradient between black and the given color. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">color</td><td>The beginning color. </td></tr>
    <tr><td class="paramname">horizontal</td><td>If YES, the bars will have a horizontal orientation, otherwise they will be vertical. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="interface_c_p_t_bar_plot.html" title="A two-dimensional bar plot.">CPTBarPlot</a> instance initialized with a linear gradient bar fill. </dd></dl>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a82f1434ff5a5b98ef005dca5feee1572"></a><!-- doxytag: member="CPTBarPlot::barWidth" ref="a82f1434ff5a5b98ef005dca5feee1572" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- CPTBarPlot:<code> [read, write, assign]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The width of each bar. Either view or plot coordinates can be used. </p>
<p>With plot coordinates, the bar locations are one data unit apart (e.g., 1, 2, 3, etc.), a value of 1.0 will result in bars that touch each other; a value of 0.5 will result in bars that are as wide as the gap between them.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interface_c_p_t_bar_plot.html#a9d1abb45a60f9daa990b9ea7d68d17f7" title="Whether the bar width and bar offset is in view coordinates, or in plot coordinates. Default is NO, meaning plot coordinates are used.">barWidthsAreInViewCoordinates</a> </dd></dl>

</div>
</div>
<a class="anchor" id="afbe47324c211948bcc6554f44cba9740"></a><!-- doxytag: member="CPTBarPlot::plotRange" ref="afbe47324c211948bcc6554f44cba9740" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- CPTBarPlot:<code> [read, write, copy]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the plot range for the independent axis. </p>
<p>If a plot range is provided, the bars are spaced evenly throughout the plot range. If plotRange is nil, bar locations are provided by Cocoa bindings or the bar plot datasource. If locations are not provided by either bindings or the datasource, the first bar will be placed at zero (0) and subsequent bars will be at successive positive integer coordinates. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Source/<a class="el" href="_c_p_t_bar_plot_8h_source.html">CPTBarPlot.h</a></li>
<li>Source/CPTBarPlot.m</li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="interface_c_p_t_bar_plot.html">CPTBarPlot</a>      </li>

    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a></li>
   </ul>
 </div>


</body>
</html>
